ZonesAdd
增加zone
请求地址
POST
http://OmsAddress/app/newoms.php/webservice/business/zones/add?cmd=10006&ip-type=webservicerest&access-token=AccessTokenVal
POST请求参数说明
参数名称 | 数据类型 | 说明 | 是否必填字段 | 备注 |
---|---|---|---|---|
set_id | 整型 | 游戏区所在的集群的id | 是 | |
app_id | 整型 | zone所在的业务的id | 是 | |
zone_id | 整型 | 游戏区的id | 是 | |
zone_group | 字符串 | 游戏区分组 | ||
zone_name | 字符串 | 游戏区名称,最大长度为63 | ||
zone_tag | 字符串 | 游戏区标签列表,由游戏区标签用分号";"拼接所得,不能超过5个游戏区标签 其中,每个游戏区标签只能包含汉字、英文字母、数字、下划线,最大长度为64 |
Data参数
使用json格式表示记录相关信息,示例如下:
{
"set_id": 126,
"app_id": 2,
"zone_id": 1005,
"zone_name": "test_add_zone",
"zone_group": "group name",
"zone_tag": "tag1;tag2;tag3;tag4;tag5;"
}
返回语法
返回参数说明
返回状态码不为200时,表示添加zone失败,返回数据为错误信息
返回状态码为200,表示zone添加成功,返回的为添加的zone的信息
请求示例
通过 curl 方法发起请求
命令中的参数请参考本页中的“POST请求参数说明”,access-token的获取方法详见:获取access-token
curl -H "Content-type: application/json" -X "POST" -d '{
"set_id": 126,
"app_id": 2,
"zone_id": 1005,
"zone_name": "test_add_zone",
"zone_group": "group name",
"zone_tag": "tag1;tag2;tag3;tag4;tag5;"
}' 'http://omsaddress/app/newoms.php/webservice/business/zones/add?cmd=10006&ip-type=webservicerest&access-token=<access-token>'
返回示例
成功返回示例
http请求的Status=200
{
"set_id": 126,
"app_id": 2,
"zone_id": 1005,
"zone_name": "test_add_zone",
"zone_group": "Normal",
"zone_tag": "tag1;tag2;tag3;tag4;tag5",
"create_date": "2017-03-03 11:56:55",
"uid": 172
}
错误返回
http请求的Status!=200
{
"name": "Unauthorized",
"message": "You are requesting with an invalid credential.",
"code": 0,
"status": 401,
"type": "yii\\web UnauthorizedHttpException"
}